/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm;


import java.util.Calendar;

import cgl.narada.wsinfra.schemas.wsrm.AcknowledgementIntervalDocument;
import cgl.narada.wsinfra.schemas.wsrm.BaseRetransmissionIntervalDocument;
import cgl.narada.wsinfra.schemas.wsrm.ExponentialBackoffDocument;
import cgl.narada.wsinfra.schemas.wsrm.InactivityTimeoutDocument;

/** This interface encapsulates the WsrmPolicies associated with a sequence. 
    Among the elements that can be set in the Policy associated with a 
    Sequence are
    
    <br>(a) Sequence creation, expiration and Termination
    <br>(b) This also provides information on the retransmission interval and
    the inactivity timeout.
     
    @author Shrideep Pallickara and Sangmi Lee
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.2 $
*/

public interface WsrmSequencePolicies {
  
  /** Check to see if sequence expiration has been specified */
  public boolean hasSequenceExpiration();

  /** Retrieve the specified sequence expiration */
  public Calendar getSequenceExpiration();


  /** Check to see if an inactivity timeout has been specified */
  public boolean hasInactivityTimeout();

  /** Retrieve specified inactivity timeout info */
  public InactivityTimeoutDocument getInactivityTimeout();

  /** Check if retransmission related policies have been specified */
  public boolean hasRetransmissionInterval();
  
  /** Retrieve the retransmission interval related policies */
  public BaseRetransmissionIntervalDocument getRetransmissionInterval();

  
  /* Check if the exponential back off has been specified */
  public boolean hasExponentialBackoff();
  
  /** Retrieve the specified exponential back off */
  public ExponentialBackoffDocument getExponentialBackoff();


  /** Check if an acknowledgement interval has been specified */
  public boolean hasAcknowledgementInterval();

  /* Retrieve the specified acknowldgement interval */
  public AcknowledgementIntervalDocument getAcknowledgementInterval();


  /** Get the byte stream representation */
  public byte[] getBytes();
}
